api_request Element

starts a connection request.

api_request

starts a connection request.

Sequence

action xs:string

One of nine action types. This lets us know the type of connection you wish to make and what you need the API to do for you. In the case of sending a job, the action type is "transfer".

cust_ref xs:string

This field is for your reference ID for this transfer request.

method xs:string

This defines the delivery method you wish to employ for this message.

username xs:string

The username of this user as stored on the PRODOCOM system. You will need to get this information from PRODOCOM before you attempt any form of API connection. Typically the username is PRODOCOM website login.

password xs:string

The password of this user as stored on the PRODOCOM system. You will need to get this information from PRODOCOM before you attempt any form of API connection.

reference xs:string

An optional field. When used with emails, this is the subject line of the email. Otherwise, can be used for client reporting purposes.

chargecode xs:string

An optional field that you can use to break up your messages on the invoice from PRODOCOM.

category xs:string

This refers to the category when sending a mobile App message only. Field value MUST match one of the message categories in your PRODOCOM supplied Mobile App.

email_from xs:string

The email address the email is to appear to come from.

email_reply xs:string

The email address that reply emails are to go back to.

email_name xs:string

The name, emails appear to come from.

sms_reply xs:string

An optional field. The reply number or header name for SMS messages. This MUST be pre-registered with PRODOCOM. If you use Alpha characters in your header, it is impossible for the recipient to reply. If you want a recipient to reply you MUST have a valid mobile number. PRODOCOM can provide inbound SMS numbers.

send_date xs:string

The date and time you want the job to be sent out. The date and time needs to be in your own local time. If you want the job sent straight away, do not include a <send_date> value.

destination

The information within a destination sequence contains the information for each intended recipient. As long as there are at least a recip_id and an address of some form that matches the <method>, the rest of the fields are optional.

Choice 0..∞

email_address xs:string

The email address of the intended recipient.

recip_id xs:string

Your systems id number for the intended recipient.

address1 xs:string

Line 1 of a recipient’s geographical address.

address2 xs:string

Line 2 of a recipient’s geographical address.

address3 xs:string

Line 3 of a recipient’s geographical address.

address4 xs:string

Line 4 of a recipient’s geographical address.

address5 xs:string

Line 5 of a recipient’s geographical address.

address6 xs:string

Line 6 of a recipient’s geographical address.

alt_fax xs:string

An alternate fax number to use if the first destination fails.

attention xs:string

Usually the first and last names of the intended recipient.

city xs:string

The city in the intended recipients geographical address.

company xs:string

The intended recipient’s company name.

custom1 xs:string

A custom command to enable you to insert information that is not otherwise covered by the other commands. It is recommended that you check with PRODOCOM before trying to use any other than custom1 through to custom10.

custom2 xs:string